Skip to content

[Bugfix #527] Fix af spawn docs: mark --protocol REQUIRED, add pre-spawn checklist#528

Merged
waleedkadous merged 2 commits intomainfrom
builder/bugfix-527-docs-fix-af-spawn-guidance-to-
Feb 23, 2026
Merged

[Bugfix #527] Fix af spawn docs: mark --protocol REQUIRED, add pre-spawn checklist#528
waleedkadous merged 2 commits intomainfrom
builder/bugfix-527-docs-fix-af-spawn-guidance-to-

Conversation

@waleedkadous
Copy link
Contributor

Summary

Agents consistently fumble af spawn commands, wasting 3-4 round-trips. The docs showed --protocol as optional and lacked a pre-spawn checklist in key files.

Fixes #527

Root Cause

Three documentation gaps caused the failure pattern:

  1. --protocol appeared optional — architect.md showed af spawn 42 without it
  2. Pre-spawn checklist (commit before spawn) was only in CLAUDE.md, not in architect.md or the af skill
  3. No recovery guidance when spawn fails — agents guessed (git pull, random retries)

Fix

Updated 5 documentation files:

  • codev-skeleton/roles/architect.md: Added pre-spawn checklist section, added --protocol to all examples, updated quick reference table
  • codev/resources/commands/agent-farm.md: Separated --protocol as REQUIRED (not just an option), added Preconditions section, added Common Errors table
  • .claude/skills/af/SKILL.md (both copies): Enhanced pre-spawn checklist to include --protocol, added "forgetting --protocol" to common mistakes
  • codev/resources/workflow-reference.md: Fixed overview diagram (af spawn XXXXaf spawn XXXX --protocol spir), added Spawn Failures troubleshooting section with recovery flow

Test Plan

  • Regression test added (bugfix-527-spawn-docs.test.ts) — scans all doc files for af spawn <number> examples and verifies they include --protocol (or use an exempted form)
  • Build passes
  • All tests pass (1968/1968, 1 pre-existing flaky timeout in porch/next.test.ts unrelated to changes)

Diff Stats

6 files changed, 190 insertions(+), 35 deletions(-) — well under 300 LOC threshold

- architect.md: Add pre-spawn checklist, add --protocol to all examples
- agent-farm.md: Separate --protocol as REQUIRED, add preconditions and
  common errors table
- SKILL.md (both copies): Mark --protocol REQUIRED in pre-spawn checklist,
  add "forgetting --protocol" to common mistakes
- workflow-reference.md: Fix overview diagram, add spawn error recovery
  section with recovery flow
- Add regression test verifying all af spawn examples include --protocol
…nd skeleton agent-farm.md

- codev/roles/architect.md: Same fixes as skeleton copy — pre-spawn
  checklist, --protocol in all examples, updated quick reference table
- codev-skeleton/resources/commands/agent-farm.md: Same fixes as
  project copy — REQUIRED --protocol, preconditions, common errors
- Regression test: Add both missed files to DOC_FILES list (now 7 files)
@waleedkadous
Copy link
Contributor Author

Architect Review

Low-risk docs-only change. Covers all the right files — architect.md, agent-farm.md, SKILL.md, workflow-reference.md (both codev and skeleton). Every af spawn <number> example now includes --protocol. Pre-spawn checklist and troubleshooting sections added in the right places. Regression test is a nice touch.


Architect review

@waleedkadous waleedkadous merged commit de172d1 into main Feb 23, 2026
6 checks passed
@waleedkadous waleedkadous deleted the builder/bugfix-527-docs-fix-af-spawn-guidance-to- branch February 23, 2026 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: fix af spawn guidance to prevent common agent mistakes

1 participant